Operation Document.AddPermission (Add Permission)

In component org.nuxeo.ecm.core.automation.coreContrib

Description

Add Permission on the input document(s). Returns the document(s).

Operation id	Document.AddPermission
Aliases	`Document.AddACL`
Category	Document
Label	Add Permission
Requires
Since

Parameters

Name	Description	Type	Required	Default value
permission	ACE permission.	string	yes
acl	ACL name.	string	no	local
begin	ACE begin date.	date	no
blockInheritance	Block inheritance or not.	boolean	no
comment	Comment	string	no
email	ACE target user/group.	string	no
end	ACE end date.	date	no
notify	Notify the user or not	boolean	no
username	ACE target user/group.	string	no
users	ACE target set of users and/or groups.	stringlist	no

Signature

Inputs	document, documents
Outputs	document, documents

Implementation Information

Implementation Class	Class: org.nuxeo.ecm.automation.core.operations.document.AddPermission
Contributing Component	org.nuxeo.ecm.core.automation.coreContrib

JSON Definition

{
  "id" : "Document.AddPermission",
  "aliases" : [ "Document.AddACL" ],
  "label" : "Add Permission",
  "category" : "Document",
  "requires" : null,
  "description" : "Add Permission on the input document(s). Returns the document(s).",
  "url" : "Document.AddPermission",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "permission",
    "description" : "ACE permission.",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "acl",
    "description" : "ACL name.",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "local" ]
  }, {
    "name" : "begin",
    "description" : "ACE begin date.",
    "type" : "date",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "blockInheritance",
    "description" : "Block inheritance or not.",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "comment",
    "description" : "Comment",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "email",
    "description" : "ACE target user/group.",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "end",
    "description" : "ACE end date.",
    "type" : "date",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "notify",
    "description" : "Notify the user or not",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "username",
    "description" : "ACE target user/group.",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "users",
    "description" : "ACE target set of users and/or groups.",
    "type" : "stringlist",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}